dxp-ux

The createTopupBalance API provides

Below features for PR:

1. createTopupBalance: allows the customer to top up their account with a mobile number that they have specified (MSISDN) or subscriptionId.
2. Retrieve Tax Info: API returns the estimated tax amount before making the top-up if we call API with field reason = TAX. Below features for PR:

Below features for PA:

1. createTopupBalance: allows the customer to top up their account with a specified MSISDN. The topup can be performed using either voucher or voucherless method.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/topupBalance

URL PARAMS

Headers

Data Model - Request

product subResource -Data Model

relatedParty subResource -Data Model

Data Model Response

product subResource -Data Model

impactBucket subResource - Data Model

impactedBucket.item subResource -Data Model

relatedParty subResource -Data Model

Key considerations

• Please refer the examples from the following URL - DXP UX - POST TopUpBalance

PA Implementation

1. This is implemented for prepaid customers.
2. Top-up is done through the Ericsson system and can be performed in two ways:
   - Voucher
   - Voucherless
3. For voucher-based top-up, the following fields are mandatory in the request:
   - bucket.id: This is the service number or MSISDN.
   - voucher: A valid voucher must be provided and currently the maximum expected length is 16 characters.
   - paymentMethod.id: A unique ID used for auditing and identifying duplicate transactions.
   - channel.name, channel.id: Specific to each payment gateway.
   - amount: As per RAML, this field is mandatory, so it must be passed as 0.0.
   - usageType: This should always be "monetary".
4. For voucherless top-up, the following fields are mandatory in the request:
   - bucket.id: This is the service number or MSISDN.
   - paymentMethod.id: This should be the transaction ID received after successful payment with the payment gateway.
   - channel.name, channel.id: Specific to each payment gateway.
   - amount: The amount chosen by the customer.
   - usageType: This should always be "monetary".
5. For each top-up, X-correlation-ID and paymentMethod.id should be unique.
6. The voucher field is not applicable for voucherless top-up use case requests.
7. For all the dateTime fields
  - Any datetime before 1908-04-22 will show offset -05:18
  - Any datetime on or after 1908-04-22 will show offset -05:00

PR Implementation

1. For TAX_INFORMATION Request:
 - The possible values of reason attributes are "TAX/ESTIMATE/TAX ESTIMATE"
 - No need to pass valid voucher (one time code/nonce) code, it will accept any dummy value.
 - id field is not applicable for Tax information using subscriptionId usecase .
 - relatedParty array and its fields are not applicable.

2. For TOPUP BALANCE Request:
 - No need to pass reason attribute.
 -  Expecting valid voucher (onetime code/nonce) code for complete top-up balance.
 - id ,  partyAccount.'@type', product array and its fields are optional.
 - reason field is not applicable.

3. For TAX_INFORMATION Response:
 -  "id" field is not applicable for Tax information using subscriptionId usecase .
 -  "confirmationDate" , relatedParty[] array and its fields are not applicable.

4. For TOPUP BALANCE Response:
 - "reason" field is not applicable.

Possible Error Scenarios for PR :

IF WE ARE PASSING INVALID (MSISDN) NUMBER IN REQUEST BODY

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:POST_TOPUP_BALANCE",
            "description": "11 | Subscriber not found (AccessNumber=709565949)"
        }
    ]
}

IF WE ARE PASSING INVALID VOUCHER IN REQUEST BODY

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:POST_TOPUP_BALANCE",
            "description": "52 | The AUTHORIZATION_AND_SETTLEMENT Request to Braintree has Failed: Invalid Payment Method Nonce QWEDRFRG"
        }
    ]
}

IF WE ARE PASSING INVALID PAYMENT Gateway ID REQUEST BODY

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:POST_TOPUP_BALANCE",
            "description": "52 | No Payment Gateway with Id 3 has been configured"
        }
    ]
}